LED Switch Tool - ActiveX Properties

CygNet Studio > Using CygNet Studio Tools and Controls > LED Switch Tool > ActiveX Properties

LED Switch Tool - ActiveX Properties

The LED Switch Tool is an ActiveX control. As such, an LED Switch Tool object has an ActiveX page on the Property Sheet. Many of these properties are the object’s formatting properties. Values for the ActiveX Properties can be set directly on the ActiveX page or in the OCX Properties dialog box, which is accessed by clicking the (OCXProperties) property.

Property	Description	Related Properties
Active	Enables the LED to be illuminated by default. Default is 0 - No.
ActiveColor	Specifies the color of the object when the value of the object’s point is "on" or illuminated. Default is green (RGB 0.255.0).
AutoFrameRate	Enables the object to control its update rate. Default is 0 - No. When set to 1 - Yes, the object is repainted at the rate specified by the UpdateFrameRate property.	UpdateFrameRate
AutoLedSize	Enables the LED to be automatically sized within the object boundary. Specifies whether the IndicatorHeight or IndicatorWidth is automatically calculated depending on the IndicatorAlignment.	IndicatorHeight IndicatorWidth IndicatorAlignment
BackGroundColor	Specifies the color of the object background. Default is gray (RGB 236.233.216). The background color is not shown if the Transparent property is set to 1 - Yes.	[AlarmElement]
BorderHighlightColor	Specifies the color of the border highlight of the object. Default is white (RGB 255.255.255).
BorderShadowColor	Specifies the shadow color of the object’s border. Default is white (RGB 255.255.255).
BorderSize	Specifies the size of the border (in pixels) of the object. Default is 2.
BorderStyle	Specifies the border style of the object. Default is 0 - ibsNone. Other options are 1 - ibsRaised and 2 - ibsLowered.
Caption	Caption specifies caption text in the following objects: For the LED Switch Tool, Caption is an ActiveX property that specifies the default label of the switch plate. In Run mode this is replaced by the item specified by the [DisplayItem] property. For the SetPoint Button Tool, Caption is a script property that specifies the title caption of the prompt dialog box. UsePrompt must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. Script subtype is string.	[DisplayItem]
CaptionAlignment	Specifies the alignment of the caption in regards to the LED. Default is 0 - islcalndicator, which means that the caption is adjacent to the LED. Other option is 1 - islcaOppositeSide.
CaptionFont	Specifies the font for the caption. Default is MS Sans Serif (8 point).
CaptionFontColor	Specifies the color of the caption. Default is black (RGB 0.0.0).
CaptionMargin	Specifies the size of the margin (in pixels) between the caption and the LED. Default is 6.
Enabled	Enables user interaction with the object. If set to 0 - No, the object is still shown but its context menu is disabled. Default is 1 - Yes.
Glyph	Specifies the bitmap shown in place of the LED. Supported file formats are bitmaps (.cur, .ico, .bmp, .dib). Note: Although Windows Metafile (.wmf) is listed as a format option, this file format is not supported.
Height	Specifies the height (in pixels) of the object.
IndicatorAlignment	Specifies the alignment of the LED indicator on the switch plate. Default is 0 - isaBottom. Other options are 1 - isaTop, 2 - isaLeft, and 3 - isaRight.	IndicatorHeight IndicatorWidth
IndicatorHeight	Specifies the height (in pixels) of the LED indicator. Default is 8.	IndicatorWidth IndicatorAlignment
IndicatorMargin	Specifies the margin (in pixels) between the LED indicator and the switch border. Default is 5.
IndicatorWidth	Specifies the width (in pixels) of the LED indicator. Default is 10.	IndicatorHeight IndicatorAlignment
OptionSaveAllProperties	Enables the SaveAllPropertiesToFile method to save just the ActiveX Properties or all object properties. Default is 0 - No, which means that only ActiveX Properties are saved.
ShowFocusRect	Enables display of the focus rectangle.	Tabstop
UpdateFrameRate	Specifies the rate (in seconds) of repainting the object. Default is 60. Applicable only when AutoFrameRate is enabled.	AutoFrameRate
Visible	Enables the visibility of the object on TheView. Default is 1 - Yes.
Width	Specifies the width (in pixels) of the object.
WordWrap	Enables wrapping of the caption. Default is 0 - No. When set to 1 - Yes, the caption is aligned at the top of the object.